Skip to content

Inscoper::ExternalDriverDescription

ExternalDriverDescription class for external device drivers. More...

#include <ExternalDriverDescription.h>

Inherits from Inscoper::DriverDescription

Inherited by Inscoper::CustomDriverDescription, Inscoper::MicroManagerDriverDescription

Public Functions

Name
ExternalDriverDescription()
Default constructor.
virtual Inscoper::EDriverType getDriverType() const =0
Get the driver type.
virtual bool isEqual(const DriverDescription & other) const override
Checks whether this driver description is identical to another one.
Inscoper::EDeviceType getDeviceType() const
Get the device type.
void setDeviceType(Inscoper::EDeviceType deviceType)
Set the device type.

Additional inherited members

Public Functions inherited from Inscoper::DriverDescription

Name
DriverDescription() =default
Default constructor.
virtual ~DriverDescription() =default
Virtual destructor.

Detailed Description

class Inscoper::ExternalDriverDescription;

ExternalDriverDescription class for external device drivers.

Note: This class is non-copyable and non-movable.

This class provides a description for drivers associated with devices connected directly to the computer, including their specific device type.

Public Functions Documentation

function ExternalDriverDescription

ExternalDriverDescription()

Default constructor.

Initializes a new instance of the ExternalDriverDescription class.

function getDriverType

virtual Inscoper::EDriverType getDriverType() const =0

Get the driver type.

Return: The driver type

Reimplements: Inscoper::DriverDescription::getDriverType

Reimplemented by: Inscoper::CustomDriverDescription::getDriverType, Inscoper::MicroManagerDriverDescription::getDriverType

Retrieves the specific type of external driver (e.g., MICRO_MANAGER, CUSTOM_DRIVER).

function isEqual

virtual bool isEqual(
    const DriverDescription & other
) const override

Checks whether this driver description is identical to another one.

Parameters:

  • other The description to compare against

Return: True if the configurations are identical, false otherwise

Reimplements: Inscoper::DriverDescription::isEqual

Reimplemented by: Inscoper::MicroManagerDriverDescription::isEqual

This method determines if two driver descriptions represent the same configuration. The application uses this to avoid unnecessary driver restarts when the configuration is unchanged.

function getDeviceType

Inscoper::EDeviceType getDeviceType() const

Get the device type.

Return: The device type

Retrieves the type of device associated with this driver.

function setDeviceType

void setDeviceType(
    Inscoper::EDeviceType deviceType
)

Set the device type.

Parameters:

  • deviceType : The device type

Sets the type of device associated with this driver.


Updated on 2026-06-23 at 10:35:19 +0200